Application Wherbarium.app

Documentation utilisateur (2017-01-14).

1. Contexte.

Cette documentation s'applique pour l'utilisation de l'application wherbarium.app sur un ordinateur Mac sous macOS, nommé ici MonMac, par un utilisateur donné, nommé ici Untel.
1.0. Première connexion à une base de données.
Lors du premier lancement de l'application sur la machine MonMac par l'utilisateur Untel, un panneau s'affiche avec des champs à remplir pour établir la connexion avec une base de données Wherbarium. La base de données doit exister, sinon un message d'erreur apparaît : la base de données est créée préalablement par un administrateur du projet Wherbarium qui donne les valeurs adéquates à Untel. A cette occasion, un certain nombre de répertoires et fichiers sont créés sur MonMac. Seuls ceux qui concernent la gestion des fichiers de photos sont présentés ici.
1.1. Gestion des fichiers de photos sur MonMac.
Les fichiers sont créés dans le répertoire /Users/Untel/Images/Wherbarium/Hostname/DBname
- Hostname et DBname sont les valeurs des paramètres entrés au 1.0.
- Images est le nom français du répertoire standard macOs qui apparaît dans le Finder ; ce nom est Pictures si l'on utilise le Terminal.
Dans ce répertoire, 5 répertoires sont créés :
- PhotosDeleted
- PhotosDownloaded
- PhotosOrphelinesDeleted
- PhotosToUpload
- PhotosUploaded
Pour l'instant, seul le répertoire PhotosToUpload nous intéresse : c'est le répertoire où placer les fichiers des photos à transférer dans la base de données DBname du serveur Hostname.
1.2. Connexion suivantes.
Lors des lancements suivants de l'application sur la machine MonMac par l'utilisateur Untel, un panneau s'affiche indiquant les paramètres de la connexion par défaut.
Si elle convient à Untel, celui-ci clique sur le bouton OK : un panneau s'ouvre informant de l'état de la connexion et propose les options possibles.
Si elle ne convient pas, celui-ci clique sur le bouton No : Untel choisit dans le menu Connexion (voir ci-après).
1.3. Notes.
...

2. Menu "Connexion".

2.1. Sous-menu "Connexion par défaut".

Ce menu permet de se connecter à la base de données définie comme base par défaut, sans avoir à fournir à nouveau les paramètres de connexion.
Voir 1.2 ci-avant.
2.2. Sous-menu "Nouvelle connexion".
Ce menu ouvre un panneau, comportant 5 champs dans lesquels on entre respectivement : Hostname, [5432], DBname, DBuser, UserPWD
- 5432 est la valeur par défaut, elle n'est pas à modifier sauf exception
- DBuser est le nom du propriétaire de la base DBname
- UserPWD est le nom du mot de passe associé à DBuser
Une fois la connexion établie un message apparaît, qu'il faut valider pour poursuivre.
2.3. Sous-menu "Connexions précédentes".
Ce menu permet de se connecter à l'une des dernières bases de données utilisées, sans avoir à fournir à nouveau les paramètres de connexion.
Il suffit de cliquer sur la ligne correspondant à la base souhaitée.
2.4. Sous-menu "Définir la prochaine connexion par défaut".
Ce menu permet de définir la prochaine connexion par défaut, celle-ci ne sera active qu'après la fermeture de la connexion courante ou la fermeture de l'application wherbarium.app..
2.5. Sous-menu "État de la connexion".
Ce menu permet de connaître l'état de la connexion, notamment les paramètres de connexion à la base de données courante.
2.6. Sous-menu "Supprimer une connexion".
Ce menu permet de supprimer une des connexion enregistrées, voir le menu Connexions précédentes.
2.7. Sous-menu "Fermer la connexion courante".
Ce menu permet de fermer la connexion courante : utile notamment pour activer une nouvelle connexion par défaut.

3. Menu "Chargement des photos".

3.1. Sous-menu "Gestion du carnet de terrain".

Ce menu permet de connecter les photos qui viennent d'être chargées à une page du carnet de terrain.
Un panneau standard (PS0) avec une liste de photos et un entête proposant les fonctionnalités correspondantes à ce sous menu.
Pour ce faire les photos sont groupées à l'aide de ce panneau et le groupe est associé à une page figurée par un nouveau panneau avec des champs à remplir.
NB : en l'état, l'opération inverse n'est pas possible : choisir une page du carnet de terrain et l'associer à une page du carnet de terrain 
3.2. Sous-menu "Téléchargement de photos".
Ce menu permet de charger dans la base de données courante les photos dont les fichiers ont été placés dans le répertoire PhotosToUpload.
Un panneau apparaît qui décrit le déroulement des opérations de chargement.
Si une photo a déjà été chargée dans la base de données un message apparaît.
S'il n'y a aucun fichier ou si aucun fichier n'est au format JPEG, un panneau d'erreur apparaît.
Une fois l'opération réalisée, les fichiers du répertoire PhotosToUpload sont transférés dans le répertoire PhotosUploaded.
Attention :
- le temps de chargement dépend du débit montant de la connexion à Internet : cela peut être long... (30'' pour un fichier de 6.4Mo avec une connexion à 1Mbit/s)
- le répertoire  peut devenir gros si on ne contrôle pas strictement la situation (notamment suppression après vérification du bon chargement).

4. Menu "Photos orphelines".

4.1. Sous-menu "Gestion des photos orphelines".

Ce menu permet
    - d'associer un groupe de photos à une plante à partir d'une liste de plantes prédéfinie, extraite du site The Plant List.
    - de supprimer un groupe de photos (les photos supprimés se retrouvent dans le répertoire PhotosOrphelinesDeleted).
On retrouve le panneau standard PS0 avec des fonctionnalités correspondantes à ce sous menu.

5. Menu "Photos associées à une plante".

5.1. Sous-menu "Gestion des photos associées à une plante".

Ce menu permet
    - de désassocier un groupe de photos d'une plante ; les photos prennent le statut de photos orphelines (elles se retrouvent dans le panneau PS0 du sous menu Gestion des photos orphelines.
    - de supprimer un groupe de photos ; si la plante auxquelles étaient associées n'a pas d'autres photos associées, la plante est supprimée du système ; les fichiers des photos se retrouvent dans le répertoire PhotosDeleted. Le nom des fichiers est celui de la plante accompagné d'un numéro d'identification interne.
    - d'ajouter une note à une photo (il n'est pas possible de sélectionner un groupe de photos et d'ajouter successivement une note à chaque photo du groupe.
5.2. Sous-menu "Télédéchargement des photos associées à une plante".
Ce menu permet de télédécharger les photos associées à une plante.
Les fichiers des photos se retrouvent dans le répertoire PhotosDownloaded. Le nom des fichiers est celui de la plante accompagné d'un numéro d'identification interne.

6. Menu "Listes et éditions".


6.0. Notes.
Les menus de cette partie ne sont pas stabilisés.
6.1. Sous-menu "Liste des ordres".
Ce menu permet de lister les ordres, familles, genres, plantes et d'afficher les photos associées.
6.2. Sous-menu "Liste des familles".
Ce menu permet de lister les familles, genres, plantes et d'afficher les photos associées.
6.3. Sous-menu "Liste des genres".
Ce menu permet de lister les genres, plantes et d'afficher les photos associées.
6.4. Sous-menu "Arborescence des ordres".
Ce menu permet de lister les ordres, familles, genres, plantes sous forme d'arborescence et d'afficher les photos associées.
6.5. Sous-menu "Arborescence des familles".
Ce menu permet de lister les familles, genres, plantes sous forme d'arborescence et d'afficher les photos associées.
6.6. Sous-menu "Arborescence des genres".
Ce menu permet de lister les genres, plantes sous forme d'arborescence et d'afficher les photos associées.
6.7. Sous-menu "Ordre d'une famille".
Ce menu permet d'afficher l'ordre d'une famille.
6.8. Sous-menu "Famille d'un genre".
Ce menu permet d'afficher la famille d'un genre.
6.9. Sous-menu "Genre d'une plante".
Ce menu permet d'afficher le genre d'une plante.
6.10. Sous-menu "Attributs d'un ordre".
Ce menu permet d'afficher les attributs d'un ordre.
6.11. Sous-menu "Attributs d'une famille".
Ce menu permet d'afficher les attributs d'une famille.
6.12. Sous-menu "Attributs d'un genre".
Ce menu permet d'afficher les attributs d'un genre.
6.13. Sous-menu "Attributs d'une plante".
Ce menu permet d'afficher les attributs d'une plante.
6.14. Sous-menu "Édition des attributs d'un ordre".
Ce menu permet d'éditer les attributs d'un ordre.
6.15. Sous-menu "Édition des attributs d'une famille".
Ce menu permet d'éditer les attributs d'une famille.
6.16. Sous-menu "Édition des attributs d'un genre".
Ce menu permet d'éditer les attributs d'un genre.
6.17. Sous-menu "Édition des attributs d'une plante".
Ce menu permet d'éditer les attributs d'une plante.

7. Menu "Administration".

7.1. Sous-menu "Sauvegarde des données en format propriétaire".

Ce menu permet de sauvegarder l'ensemble des données complètes de la base de données en format propriétaire.
Pour chaque photo : un fichier JPEG de la photo d'origine ; un fichier XML des différents attributs associés à la photo ; les deux fichiers ont le nom de la photo (nom de la plante + numéro interne de la photo).

7.2. Sous-menu "Restauration des données en format propriétaire".

Ce menu permet de restaurer un ensemble de données  en format propriétaire, cf. ci-dessus